client-presence: Mark disconnected clientId to sessionId mappings #24865
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
area: framework
There was a problem hiding this comment.
Pull Request Overview
This PR adds a mechanism to mark disconnected client–session mappings in the system datastore so that newly joined clients can see which session IDs are no longer in use.
- Introduce an optional
disconnectedflag onConnectionValueState - Fetch and assert the existing session mapping for a client and set its
disconnectedflag when the client is removed
Comments suppressed due to low confidence (3)
packages/framework/presence/src/systemWorkspace.ts:222
- [nitpick] The variable name
knownSessionIDsuggests it holds an ID string, yet it’s later treated as an object. Consider renaming it tosessionIdand fetching the session state object into a separate variable for clarity.
const knownSessionID = this.datastore.clientToSessionId[clientConnectionId];
packages/framework/presence/src/systemWorkspace.ts:225
- It would be good to add a unit test to verify that the
disconnectedflag is set correctly on the session state when a client is removed, ensuring this new flag behaves as expected.
knownSessionID.disconnected = true;
packages/framework/presence/src/systemWorkspace.ts:225
- The value returned by
clientToSessionId[clientConnectionId]is likely a primitive session ID (string), so assigning adisconnectedproperty will fail at runtime. You should first retrieve the correspondingConnectionValueStateobject from your datastore and then mark itsdisconnectedflag.
knownSessionID.disconnected = true;
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In this change we mark the disconnected clientId to sessionId in the system datastore once they are removed. This information will be useful to newly joined clients, as they can know which connectionIds are not in use anymore.